home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.3 / LinkVar.3 < prev    next >
Text File  |  1995-07-17  |  8KB  |  295 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/LinkVar.3,v 1.4 93/07/28 15:18:56 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tcl_LinkVar tclc 7.0
  206. .BS
  207. .SH NAME
  208. .na
  209. Tcl_LinkVar, Tcl_UnlinkVar \- link Tcl variable to C variable
  210. .ad
  211. .SH SYNOPSIS
  212. .nf
  213. \fB#include <tcl.h>\fR
  214. .sp
  215. int
  216. \fBTcl_LinkVar\fR(\fIinterp, varName, addr, type\fR)
  217. .sp
  218. \fBTcl_UnlinkVar\fR(\fIinterp, varName\fR)
  219. .SH ARGUMENTS
  220. .AS Tcl_Interp writable
  221. .AP Tcl_Interp *interp in
  222. Interpreter that contains \fIvarName\fR.
  223. Also used by \fBTcl_LinkVar\fR to return error messages.
  224. .AP char *varName in
  225. Name of global variable.
  226. .AP char *addr in
  227. Address of C variable that is to be linked to \fIvarName\fR.
  228. .AP int type in
  229. .na
  230. Type of C variable.  Must be one of TCL_LINK_INT, TCL_LINK_DOUBLE,
  231. TCL_LINK_BOOLEAN, or TCL_LINK_STRING, optionally OR'ed with
  232. TCL_LINK_READ_ONLY to make Tcl variable read-only.
  233. .ad
  234. .BE
  235.  
  236. .SH DESCRIPTION
  237. .PP
  238. \fBTcl_LinkVar\fR uses variable traces to keep the Tcl variable
  239. named by \fIvarName\fR in sync with the C variable at the address
  240. given by \fIaddr\fR.
  241. Whenever the Tcl variable is read the value of the C variable will
  242. be returned, and whenever the Tcl variable is written the C
  243. variable will be updated to have the same value.
  244. \fBTcl_LinkVar\fR normally returns TCL_OK;  if an error occurs
  245. while setting up the link (e.g. because \fIvarName\fR is the
  246. name of array) then TCL_ERROR is returned and \fIinterp->result\fR
  247. contains an error message.
  248. .PP
  249. The \fItype\fR argument specifies the type of the C variable,
  250. and must have one of the following values, optionally OR'ed with
  251. TCL_LINK_READ_ONLY:
  252. .TP
  253. \fBTCL_LINK_INT\fR
  254. The C variable is of type \fBint\fR.
  255. Any value written into the Tcl variable must have a proper integer
  256. form acceptable to \fBTcl_GetInt\fR;  attempts to write
  257. non-integer values into \fIvarName\fR will be rejected with
  258. Tcl errors.
  259. .TP
  260. \fBTCL_LINK_DOUBLE\fR
  261. The C variable is of type \fBdouble\fR.
  262. Any value written into the Tcl variable must have a proper real
  263. form acceptable to \fBTcl_GetDouble\fR;  attempts to write
  264. non-real values into \fIvarName\fR will be rejected with
  265. Tcl errors.
  266. .TP
  267. \fBTCL_LINK_BOOLEAN\fR
  268. The C variable is of type \fBint\fR.
  269. If its value is zero then it will read from Tcl as ``0'';
  270. otherwise it will read from Tcl as ``1''.
  271. Whenver \fIvarName\fR is
  272. modified, the C variable will be set to a 0 or 1 value.
  273. Any value written into the Tcl variable must have a proper boolean
  274. form acceptable to \fBTcl_GetBoolean\fR;  attempts to write
  275. non-boolean values into \fIvarName\fR will be rejected with
  276. Tcl errors.
  277. .TP
  278. \fBTCL_LINK_STRING\fR
  279. The C variable is of type \fBchar *\fR.
  280. If its value is not null then it must be a pointer to a string
  281. allocated with \fBmalloc\fR.
  282. Whenever the Tcl variable is modified the current C string will be
  283. freed and new memory will be allocated to hold a copy of the variable's
  284. new value.
  285. If the C variable contains a null pointer then the Tcl variable
  286. will read as ``NULL''.
  287. .PP
  288. If the TCL_LINK_READ_ONLY flag is present in \fItype\fR then the
  289. variable will be read-only from Tcl, so that its value can only be
  290. changed by modifying the C variable.
  291. Attempts to write the variable from Tcl will be rejected with errors.
  292.  
  293. .SH KEYWORDS
  294. boolean, integer, link, read-only, real, string, variable
  295.